home *** CD-ROM | disk | FTP | other *** search
/ PC Advisor 2011 May / PC Advisor 190 E.iso / pc / ESSENTIALS / VLC Media Player 1.1 / vlc-1.1.5-win32.exe / sdk / include / vlc / plugins / vlc_configuration.h < prev    next >
Encoding:
C/C++ Source or Header  |  2010-11-13  |  12.8 KB  |  328 lines
  1. /*****************************************************************************
  2.  * configuration.h : configuration management module
  3.  * This file describes the programming interface for the configuration module.
  4.  * It includes functions allowing to declare, get or set configuration options.
  5.  *****************************************************************************
  6.  * Copyright (C) 1999-2006 the VideoLAN team
  7.  * $Id: e9f88f07e6238458a81fa0f14c82f6f2c45572cd $
  8.  *
  9.  * Authors: Gildas Bazin <gbazin@videolan.org>
  10.  *
  11.  * This program is free software; you can redistribute it and/or modify
  12.  * it under the terms of the GNU General Public License as published by
  13.  * the Free Software Foundation; either version 2 of the License, or
  14.  * (at your option) any later version.
  15.  *
  16.  * This program is distributed in the hope that it will be useful,
  17.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19.  * GNU General Public License for more details.
  20.  *
  21.  * You should have received a copy of the GNU General Public License
  22.  * along with this program; if not, write to the Free Software
  23.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24.  *****************************************************************************/
  25.  
  26. #ifndef VLC_CONFIGURATION_H
  27. #define VLC_CONFIGURATION_H 1
  28.  
  29. /**
  30.  * \file
  31.  * This file describes the programming interface for the configuration module.
  32.  * It includes functions allowing to declare, get or set configuration options.
  33.  */
  34.  
  35. # ifdef __cplusplus
  36. extern "C" {
  37. # endif
  38.  
  39. /*****************************************************************************
  40.  * Macros used to build the configuration structure.
  41.  *****************************************************************************/
  42.  
  43. /* Configuration hint types */
  44.  
  45.  
  46. #define CONFIG_HINT_CATEGORY                0x0002  /* Start of new category */
  47. #define CONFIG_HINT_SUBCATEGORY             0x0003  /* Start of sub-category */
  48. #define CONFIG_HINT_SUBCATEGORY_END         0x0004  /* End of sub-category */
  49. #define CONFIG_HINT_USAGE                   0x0005  /* Usage information */
  50.  
  51. #define CONFIG_CATEGORY                     0x0006 /* Set category */
  52. #define CONFIG_SUBCATEGORY                  0x0007 /* Set subcategory */
  53. #define CONFIG_SECTION                      0x0008 /* Start of new section */
  54.  
  55. #define CONFIG_HINT                         0x000F
  56.  
  57. /* Configuration item types */
  58. #define CONFIG_ITEM_STRING                  0x0010  /* String option */
  59. #define CONFIG_ITEM_FILE                    0x0020  /* File option */
  60. #define CONFIG_ITEM_MODULE                  0x0030  /* Module option */
  61. #define CONFIG_ITEM_INTEGER                 0x0040  /* Integer option */
  62. #define CONFIG_ITEM_BOOL                    0x0050  /* Bool option */
  63. #define CONFIG_ITEM_FLOAT                   0x0060  /* Float option */
  64. #define CONFIG_ITEM_DIRECTORY               0x0070  /* Directory option */
  65. #define CONFIG_ITEM_KEY                     0x0080  /* Hot key option */
  66. #define CONFIG_ITEM_MODULE_CAT              0x0090  /* Module option */
  67. #define CONFIG_ITEM_MODULE_LIST             0x00A0  /* Module option */
  68. #define CONFIG_ITEM_MODULE_LIST_CAT         0x00B0  /* Module option */
  69. #define CONFIG_ITEM_FONT                    0x00C0  /* Font option */
  70. #define CONFIG_ITEM_PASSWORD                0x00D0  /* Password option (*) */
  71.  
  72. #define CONFIG_ITEM                         0x00F0
  73.  
  74. /*******************************************************************
  75.  * All predefined categories and subcategories
  76.  *******************************************************************/
  77. #define CAT_INTERFACE 1
  78.    #define SUBCAT_INTERFACE_GENERAL 101
  79.    #define SUBCAT_INTERFACE_MAIN 102
  80.    #define SUBCAT_INTERFACE_CONTROL 103
  81.    #define SUBCAT_INTERFACE_HOTKEYS 104
  82.  
  83. #define CAT_AUDIO 2
  84.    #define SUBCAT_AUDIO_GENERAL 201
  85.    #define SUBCAT_AUDIO_AOUT 202
  86.    #define SUBCAT_AUDIO_AFILTER 203
  87.    #define SUBCAT_AUDIO_VISUAL 204
  88.    #define SUBCAT_AUDIO_MISC 205
  89.  
  90. #define CAT_VIDEO 3
  91.    #define SUBCAT_VIDEO_GENERAL 301
  92.    #define SUBCAT_VIDEO_VOUT 302
  93.    #define SUBCAT_VIDEO_VFILTER 303
  94.    #define SUBCAT_VIDEO_TEXT 304
  95.    #define SUBCAT_VIDEO_SUBPIC 305
  96.    #define SUBCAT_VIDEO_VFILTER2 306
  97.  
  98. #define CAT_INPUT 4
  99.    #define SUBCAT_INPUT_GENERAL 401
  100.    #define SUBCAT_INPUT_ACCESS 402
  101.    #define SUBCAT_INPUT_DEMUX 403
  102.    #define SUBCAT_INPUT_VCODEC 404
  103.    #define SUBCAT_INPUT_ACODEC 405
  104.    #define SUBCAT_INPUT_SCODEC 406
  105.    #define SUBCAT_INPUT_STREAM_FILTER 407
  106.  
  107. #define CAT_SOUT 5
  108.    #define SUBCAT_SOUT_GENERAL 501
  109.    #define SUBCAT_SOUT_STREAM 502
  110.    #define SUBCAT_SOUT_MUX 503
  111.    #define SUBCAT_SOUT_ACO 504
  112.    #define SUBCAT_SOUT_PACKETIZER 505
  113.    #define SUBCAT_SOUT_SAP 506
  114.    #define SUBCAT_SOUT_VOD 507
  115.  
  116. #define CAT_ADVANCED 6
  117.    #define SUBCAT_ADVANCED_CPU 601
  118.    #define SUBCAT_ADVANCED_MISC 602
  119.    #define SUBCAT_ADVANCED_NETWORK 603
  120.    #define SUBCAT_ADVANCED_XML 604
  121.  
  122. #define CAT_PLAYLIST 7
  123.    #define SUBCAT_PLAYLIST_GENERAL 701
  124.    #define SUBCAT_PLAYLIST_SD 702
  125.    #define SUBCAT_PLAYLIST_EXPORT 703
  126.  
  127. #define CAT_OSD 8
  128.    #define SUBCAT_OSD_IMPORT 801
  129.  
  130. struct config_category_t
  131. {
  132.     int         i_id;
  133.     const char *psz_name;
  134.     const char *psz_help;
  135. };
  136.  
  137. typedef union
  138. {
  139.     char       *psz;
  140.     int         i;
  141.     float       f;
  142. } module_value_t;
  143.  
  144. typedef union
  145. {
  146.     int         i;
  147.     float       f;
  148. } module_nvalue_t;
  149.  
  150. struct module_config_t
  151. {
  152.     int          i_type;                               /* Configuration type */
  153.     char        *psz_type;                          /* Configuration subtype */
  154.     char        *psz_name;                                    /* Option name */
  155.     char         i_short;                      /* Optional short option name */
  156.     char        *psz_text;      /* Short comment on the configuration option */
  157.     char        *psz_longtext;   /* Long comment on the configuration option */
  158.     module_value_t value;                                    /* Option value */
  159.     module_value_t orig;
  160.     module_value_t saved;
  161.     module_nvalue_t min;
  162.     module_nvalue_t max;
  163.  
  164.     /* Function to call when commiting a change */
  165.     vlc_callback_t pf_callback;
  166.     void          *p_callback_data;
  167.  
  168.     /* Values list */
  169.     char **      ppsz_list;       /* List of possible values for the option */
  170.     int         *pi_list;                              /* Idem for integers */
  171.     char       **ppsz_list_text;          /* Friendly names for list values */
  172.     int          i_list;                               /* Options list size */
  173.     vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */
  174.  
  175.     /* Actions list */
  176.     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
  177.     char          **ppsz_action_text;         /* Friendly names for actions */
  178.     int            i_action;                           /* actions list size */
  179.  
  180.     /* Misc */
  181.     bool        b_dirty;          /* Dirty flag to indicate a config change */
  182.     bool        b_advanced;          /* Flag to indicate an advanced option */
  183.     bool        b_internal;   /* Flag to indicate option is not to be shown */
  184.     bool        b_restart;   /* Flag to indicate the option needs a restart */
  185.                               /* to take effect */
  186.  
  187.     /* Deprecated */
  188.     char        *psz_oldname;                          /* Old option name */
  189.     bool        b_removed;
  190.  
  191.     /* Option values loaded from config file */
  192.     bool        b_autosave;      /* Config will be auto-saved at exit time */
  193.     bool        b_unsaveable;                /* Config should not be saved */
  194.  
  195.     bool        b_safe;
  196. };
  197.  
  198. /*****************************************************************************
  199.  * Prototypes - these methods are used to get, set or manipulate configuration
  200.  * data.
  201.  *****************************************************************************/
  202. VLC_EXPORT( int,    config_GetType,  (vlc_object_t *, const char *) LIBVLC_USED );
  203. VLC_EXPORT( int,    config_GetInt,   (vlc_object_t *, const char *) LIBVLC_USED );
  204. VLC_EXPORT( void,   config_PutInt,   (vlc_object_t *, const char *, int) );
  205. VLC_EXPORT( float,  config_GetFloat, (vlc_object_t *, const char *) LIBVLC_USED );
  206. VLC_EXPORT( void,   config_PutFloat, (vlc_object_t *, const char *, float) );
  207. VLC_EXPORT( char *, config_GetPsz,   (vlc_object_t *, const char *) LIBVLC_USED );
  208. VLC_EXPORT( void,   config_PutPsz,   (vlc_object_t *, const char *, const char *) );
  209.  
  210. VLC_EXPORT( int,    config_SaveConfigFile, ( vlc_object_t *, const char * ) );
  211. #define config_SaveConfigFile(a,b) config_SaveConfigFile(VLC_OBJECT(a),b)
  212. VLC_EXPORT( void,   config_ResetAll, ( vlc_object_t * ) );
  213. #define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
  214.  
  215. VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) LIBVLC_USED );
  216. VLC_EXPORT(char *, config_GetDataDir, ( vlc_object_t * ) LIBVLC_USED);
  217. #define config_GetDataDir(a) config_GetDataDir(VLC_OBJECT(a))
  218. VLC_EXPORT(const char *, config_GetLibDir, ( void ) LIBVLC_USED);
  219. VLC_EXPORT(const char *, config_GetConfDir, ( void ) LIBVLC_USED);
  220.  
  221. typedef enum vlc_userdir
  222. {
  223.     VLC_HOME_DIR, /* User's home */
  224.     VLC_CONFIG_DIR, /* VLC-specific configuration directory */
  225.     VLC_DATA_DIR, /* VLC-specific data directory */
  226.     VLC_CACHE_DIR, /* VLC-specific user cached data directory */
  227.     /* Generic directories (same as XDG) */
  228.     VLC_DESKTOP_DIR=0x80,
  229.     VLC_DOWNLOAD_DIR,
  230.     VLC_TEMPLATES_DIR,
  231.     VLC_PUBLICSHARE_DIR,
  232.     VLC_DOCUMENTS_DIR,
  233.     VLC_MUSIC_DIR,
  234.     VLC_PICTURES_DIR,
  235.     VLC_VIDEOS_DIR,
  236. } vlc_userdir_t;
  237.  
  238. VLC_EXPORT(char *, config_GetUserDir, ( vlc_userdir_t ) LIBVLC_USED);
  239.  
  240. VLC_EXPORT( void, config_AddIntf,    ( vlc_object_t *, const char * ) );
  241. VLC_EXPORT( void, config_RemoveIntf, ( vlc_object_t *, const char * ) );
  242. VLC_EXPORT( bool, config_ExistIntf,  ( vlc_object_t *, const char * ) LIBVLC_USED);
  243.  
  244. #define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
  245. #define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
  246. #define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
  247. #define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
  248. #define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
  249. #define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
  250. #define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
  251.  
  252. #define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
  253. #define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
  254. #define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
  255.  
  256. /****************************************************************************
  257.  * config_chain_t:
  258.  ****************************************************************************/
  259. struct config_chain_t
  260. {
  261.     config_chain_t *p_next;     /**< Pointer on the next config_chain_t element */
  262.  
  263.     char        *psz_name;      /**< Option name */
  264.     char        *psz_value;     /**< Option value */
  265. };
  266.  
  267. /**
  268.  * This function will
  269.  * - create all options in the array ppsz_options (var_Create).
  270.  * - parse the given linked list of config_chain_t and set the value (var_Set).
  271.  *
  272.  * The option names will be created by adding the psz_prefix prefix.
  273.  */
  274. VLC_EXPORT( void, config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) );
  275. #define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
  276.  
  277. /**
  278.  * This function will parse a configuration string (psz_string) and
  279.  * - set the module name (*ppsz_name)
  280.  * - set all options for this module in a chained list (*pp_cfg)
  281.  * - returns a pointer on the next module if any.
  282.  *
  283.  * The string format is
  284.  *   module{option=*,option=*}[:modulenext{option=*,...}]
  285.  *
  286.  * The options values are unescaped using config_StringUnescape.
  287.  */
  288. VLC_EXPORT( char *, config_ChainCreate, ( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) ) LIBVLC_USED LIBVLC_MALLOC;
  289.  
  290. /**
  291.  * This function will release a linked list of config_chain_t
  292.  * (Including the head)
  293.  */
  294. VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) );
  295.  
  296. /**
  297.  * This function will duplicate a linked list of config_chain_t
  298.  */
  299. VLC_EXPORT( config_chain_t *, config_ChainDuplicate, ( const config_chain_t * ) );
  300.  
  301. /**
  302.  * This function will unescape a string in place and will return a pointer on
  303.  * the given string.
  304.  * No memory is allocated by it (unlike config_StringEscape).
  305.  * If NULL is given as parameter nothing will be done (NULL will be returned).
  306.  *
  307.  * The following sequences will be unescaped (only one time):
  308.  * \\ \' and \"
  309.  */
  310. VLC_EXPORT( char *, config_StringUnescape, ( char *psz_string ) );
  311.  
  312. /**
  313.  * This function will escape a string that can be unescaped by
  314.  * config_StringUnescape.
  315.  * The returned value is allocated by it. You have to free it once you
  316.  * do not need it anymore (unlike config_StringUnescape).
  317.  * If NULL is given as parameter nothing will be done (NULL will be returned).
  318.  *
  319.  * The escaped characters are ' " and \
  320.  */
  321. VLC_EXPORT( char *, config_StringEscape, ( const char *psz_string ) LIBVLC_USED);
  322.  
  323. # ifdef __cplusplus
  324. }
  325. # endif
  326.  
  327. #endif /* _VLC_CONFIGURATION_H */
  328.